home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_guile.idb / usr / freeware / include / libguile / struct.h.z / struct.h
Encoding:
C/C++ Source or Header  |  2002-07-08  |  6.3 KB  |  137 lines
  1. /* classes: h_files */
  2.  
  3. #ifndef SCM_STRUCT_H
  4. #define SCM_STRUCT_H
  5. /* Copyright (C) 1995,1997,1999,2000,2001 Free Software Foundation, Inc.
  6.  * 
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License as published by
  9.  * the Free Software Foundation; either version 2, or (at your option)
  10.  * any later version.
  11.  * 
  12.  * This program is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15.  * GNU General Public License for more details.
  16.  * 
  17.  * You should have received a copy of the GNU General Public License
  18.  * along with this software; see the file COPYING.  If not, write to
  19.  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20.  * Boston, MA 02111-1307 USA
  21.  *
  22.  * As a special exception, the Free Software Foundation gives permission
  23.  * for additional uses of the text contained in its release of GUILE.
  24.  *
  25.  * The exception is that, if you link the GUILE library with other files
  26.  * to produce an executable, this does not by itself cause the
  27.  * resulting executable to be covered by the GNU General Public License.
  28.  * Your use of that executable is in no way restricted on account of
  29.  * linking the GUILE library code into it.
  30.  *
  31.  * This exception does not however invalidate any other reasons why
  32.  * the executable file might be covered by the GNU General Public License.
  33.  *
  34.  * This exception applies only to the code released by the
  35.  * Free Software Foundation under the name GUILE.  If you copy
  36.  * code from other Free Software Foundation releases into a copy of
  37.  * GUILE, as the General Public License permits, the exception does
  38.  * not apply to the code that you add in this way.  To avoid misleading
  39.  * anyone as to the status of such modified files, you must delete
  40.  * this exception notice from them.
  41.  *
  42.  * If you write modifications of your own for GUILE, it is your choice
  43.  * whether to permit this exception to apply to your modifications.
  44.  * If you do not wish that, delete this exception notice.  */
  45.  
  46.  
  47.  
  48. #include "libguile/__scm.h"
  49. #include "libguile/print.h"
  50.  
  51.  
  52.  
  53. /* Number of words with negative index */
  54. #define scm_struct_n_extra_words 4
  55. #define scm_struct_entity_n_extra_words 6
  56.  
  57. /* These are how the initial words of a vtable are allocated. */
  58. #define scm_struct_i_setter    -6 /* Setter */
  59. #define scm_struct_i_procedure    -5 /* Optional procedure slot */
  60. #define scm_struct_i_free    -4 /* Destructor */
  61. #define scm_struct_i_ptr    -3 /* Start of block (see alloc_struct) */
  62. #define scm_struct_i_n_words    -2 /* How many words allocated to this struct? */
  63. #define scm_struct_i_size    -1 /* Instance size */
  64. #define scm_struct_i_flags    -1 /* Upper 12 bits used as flags */
  65. #define scm_vtable_index_layout  0 /* A symbol describing the physical arrangement of this type. */
  66. #define scm_vtable_index_vcell   1 /* An opaque word, managed by the garbage collector.  */
  67. #define scm_vtable_index_vtable  2 /* A pointer to the handle for this vtable. */
  68. #define scm_vtable_index_printer 3 /* A printer for this struct type. */
  69. #define scm_vtable_offset_user   4 /* Where do user fields start? */
  70.  
  71. typedef size_t (*scm_t_struct_free) (scm_t_bits * vtable, scm_t_bits * data);
  72.  
  73. #define SCM_STRUCTF_MASK   (0xFFF << 20)
  74. #define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
  75. #define SCM_STRUCTF_LIGHT  (1L << 31) /* Light representation
  76.                      (no hidden words) */
  77.  
  78. /* Dirk:FIXME:: the SCM_STRUCTP predicate is also fulfilled for glocs */
  79. #define SCM_STRUCTP(X)          (SCM_NIMP(X) && (SCM_TYP3(X) == scm_tc3_cons_gloc))
  80. #define SCM_STRUCT_DATA(X)         ((scm_t_bits *) SCM_CELL_WORD_1 (X))
  81. #define SCM_STRUCT_VTABLE_DATA(X)       ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_cons_gloc))
  82.  
  83. #define SCM_STRUCT_LAYOUT(X)             (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout]))
  84. #define SCM_SET_STRUCT_LAYOUT(X, v)     (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v))
  85.  
  86. #define SCM_STRUCT_VTABLE(X)             (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable]))
  87. #define SCM_STRUCT_VTABLE_FLAGS(X) \
  88.   (SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags])
  89. #define SCM_STRUCT_PRINTER(X)             (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer]))
  90. #define SCM_SET_STRUCT_PRINTER(x, v)\
  91.    (SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v))
  92. #define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D))
  93. /* Efficiency is important in the following macro, since it's used in GC */
  94. #define SCM_LAYOUT_TAILP(X)        (((X) & 32) == 0) /* R, W or O */
  95.  
  96. #define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
  97. #define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
  98. #define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
  99. #define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
  100. extern SCM scm_struct_table;
  101.  
  102. #define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X)
  103. #define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y)
  104. extern SCM scm_structs_to_free;
  105.  
  106.  
  107.  
  108. extern scm_t_bits * scm_alloc_struct (int n_words, int n_extra, char * who);
  109. extern size_t scm_struct_free_0 (scm_t_bits * vtable, scm_t_bits * data);
  110. extern size_t scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data);
  111. extern size_t scm_struct_free_standard (scm_t_bits * vtable, scm_t_bits * data);
  112. extern size_t scm_struct_free_entity (scm_t_bits * vtable, scm_t_bits * data);
  113. extern SCM scm_make_struct_layout (SCM fields);
  114. extern SCM scm_struct_p (SCM x);
  115. extern SCM scm_struct_vtable_p (SCM x);
  116. extern SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
  117. extern SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
  118. extern SCM scm_struct_ref (SCM handle, SCM pos);
  119. extern SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
  120. extern SCM scm_struct_vtable (SCM handle);
  121. extern SCM scm_struct_vtable_tag (SCM handle);
  122. extern unsigned long scm_struct_ihashq (SCM obj, unsigned long n);
  123. extern SCM scm_struct_create_handle (SCM obj);
  124. extern SCM scm_struct_vtable_name (SCM vtable);
  125. extern SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
  126. extern void scm_print_struct (SCM exp, SCM port, scm_print_state *);
  127. extern void scm_struct_prehistory (void);
  128. extern void scm_init_struct (void);
  129.  
  130. #endif  /* SCM_STRUCT_H */
  131.  
  132. /*
  133.   Local Variables:
  134.   c-file-style: "gnu"
  135.   End:
  136. */
  137.